ccw_Error.h

Go to the documentation of this file.

// File Revision
// Rev 1.04
//
// Rev. notes:
// - rel 1.00: first release
// - rel 1.01: Added CcwResult_CodePageUnsupported
// - rel 1.02: Added CcwResult_CommunicationPortBusy and CcwResult_FuncChannelClosed
// - rel 1.03: Added CcwResult_CounterUnsupported
// - rel 1.04: Added CcwResult_UnsupportedOperation
// NOTE: Please DO NOT EDIT THIS FILE
 
 
#ifndef _COMMON_CCW_ERROR_H__
#define _COMMON_CCW_ERROR_H__
 
 
typedef enum : DWORD
{
        CcwResult_OK = 0,                                       
 
        CcwResult_OpenDeviceError = 1,
 
        CcwResult_UnsupportedFunction = 2,
 
        CcwResult_InvalidParameter = 3,
 
        CcwResult_SmallBuffer = 4,
 
        CcwResult_NullPointer = 5,
 
        CcwResult_NotInitialized = 6,
 
        CcwResult_InvalidDeviceID = 7,
 
        CcwResult_ReadError = 8,
 
        CcwResult_WriteError = 9,
 
        CcwResult_UnsupportedDevice = 10,
 
        CcwResult_CommunicationError = 11,
 
        CcwResult_BarcodeUnsupportedError = 12,
 
        CcwResult_BarcodeWidthError = 13,
 
        CcwResult_DeviceAlreadyOpenError = 14,
 
        CcwResult_PrinterNotExistError = 15,
 
        CcwResult_UnknowPrinterError = 16,
 
        CcwResult_OpenFileError = 17,
 
        CcwResult_CommunicationBusy = 18,
 
        CcwResult_CodePageUnsupported = 19,
 
        CcwResult_CommunicationPortBusy = 20,
 
        CcwResult_FuncChannelClosed = 21,
 
        CcwResult_CounterUnsupported = 22,
 
        CcwResult_UnsupportedOperation = 23,
 
        CcwResult_UnknowError = 0xFFFFFFFF,
                
} CcwResult;
 
 
 
 
// Hide in documentation
 
typedef struct
{
        CcwResult               ccwError;
        const wchar_t*  strDescription;
} CcwErrorType;
 
//Errors List Size
#define ERROR_CCW_LISTSIZE              (sizeof(ERROR_CCW_LIST)/sizeof(CcwErrorType))
 
//Errors List description                                                               
const CcwErrorType ERROR_CCW_LIST[] = {
        // Error                                                        // Error Descrition
        { CcwResult_OK,                                         L"Ok" },
        { CcwResult_OpenDeviceError,            L"Open port or device Error" },
        { CcwResult_UnsupportedFunction,        L"Function not supported by this device" },
        { CcwResult_InvalidParameter,           L"Parameter value not valid" },
        { CcwResult_SmallBuffer,                        L"Buffer small" },
        { CcwResult_NullPointer,                        L"A parameter is NULL" },
        { CcwResult_NotInitialized,                     L"Library not initialized" },
        { CcwResult_InvalidDeviceID,            L"Device ID not valid or unknown" },
        { CcwResult_ReadError,                          L"Read data error" },
        { CcwResult_WriteError,                         L"Write data error" },
        { CcwResult_UnsupportedDevice,          L"Device unknown or unsupported" },
        { CcwResult_CommunicationError,         L"Communication error" },
        { CcwResult_BarcodeUnsupportedError, L"Barcode type unknown or unsupported" },
        { CcwResult_BarcodeWidthError,          L"Barcode width wrong or bigger than print width" },
        { CcwResult_DeviceAlreadyOpenError, L"Device already open" },
        { CcwResult_PrinterNotExistError,       L"Printer not found" },
        { CcwResult_UnknowPrinterError,         L"Unknown Printer" },
        { CcwResult_OpenFileError,                      L"File not found or open error" },
        { CcwResult_CommunicationBusy,          L"The communication with the device is busy" },
        { CcwResult_CodePageUnsupported,        L"The codepage selected is unsupported" },      
        { CcwResult_CommunicationPortBusy,      L"The communication port selected is busy so it's used by another software" },
        { CcwResult_FuncChannelClosed,          L"This function needs to use a communication channel currently closed" },
        { CcwResult_CounterUnsupported,         L"The counter request is unsupported" },
        { CcwResult_UnsupportedOperation,       L"Operation not supported by this device or by this driver" },
 
};
 
 
// @endcond
 
 
static const wchar_t* CcwResultToText(CcwResult result)
{
        DWORD i;
 
        for (i = 0; i<ERROR_CCW_LISTSIZE; i++)
        {
                if (ERROR_CCW_LIST[i].ccwError == result)
                        return ERROR_CCW_LIST[i].strDescription;
        }
 
        return L"Unknown Error";
}
 
 
#endif